When you're ready to schedule your publication, select Schedule from the Home ribbon. You can then configure your scheduling and distribution preferences from the Schedule panel. Scheduling can also be set from the content explorer interface. The Content Explorer also provides an interface for managing your schedules and viewing rendered output.
Note: Administrators can view all schedules in the system from the administrative console.
Important: This feature is not available in the Community Edition.
Opening the Schedule panel
From the Publish ribbon, click Schedule (purple arrow) to open the Schedule panel and begin creating a new Schedule for your publication:
This option also has a drop-down menu, where you can select either to create a New Schedule or view and edit any existing Schedules (Go to schedule listings). The existing schedules are opened in the Scheduling page of the Content Explorer. For more details, see Scheduling and Subscriptions.
Tip: If the Schedule button is disabled, you may need to save your publication.
New Schedule
The following sections allow you to configure a new schedule for your publication; defining when to build output documents, where to distribute the output of your publication to (Bulletin Boards, Emails, and so on), and so on.
Tip: If you want to familiarize yourself with a typical use of this functionality, you might want to walkthrough the Schedule step in the Publish Pro Getting Started guide.
Job Details
The Job Details section of the Schedule Panel describes the schedule job itself:
- Name: The name of your publication schedule. This name defaults to match the name of the publication.
- Description: Optional. The schedule's description.
- Output: The format that you would like the publication to be built in. The available output types are: PDF, PowerPoint, Word, Excel, HTML, PNG, CSV, JSON, and XML.
Output Settings
The Output settings section of the Schedule Panel define the options relating to the publication format that you selected in the Job Details section:
Note: The preceding example shows the Output settings section as it appears for a PDF. The options where you are building a PDF are Add Bookmarks and Add Link-back.
Add Bookmarks (PDF only)
When you are building publications as PDFs, either manually or as part of a schedule or subscription, you can select the Add Bookmark option to create a "document outline" that reflects the headings in your publication. Your readers can then use the hyperlinks in their PDF's document outline to navigate the document.
- Click here for more information about bookmarks
Add Link-back
When you are building publications, either manually or as part of a schedule or subscription, you can select the Add Link-back option to create a link between the visuals in the publication and the "live" version of the same visuals in Pyramid. This allows your readers to click a visual in, say, their PDF to open the latest version of that visual. Once open, they can dynamically interact with the visual, changing slicer selections, and using the options on the context menus as needed.
- Click here for more information about "link-back"
Other options
PNG, Power Point, and Word
- Image Quality: Select whether to incorporate images at low, medium, or high quality.
Excel
- You can show or hide the title and breadcrumbs for visuals, freeze worksheet panes, ignore styling, and merge common cells.
For more information, see Print and Export.
CSV, JSON, XML
- Show unique names: Include unique names for each value.
- Show caption as column header: Include the caption as a column header. Where this option is not selected, the column header caption is null.
- Remove value based filters: Where a value-based filter has been applied to data, select this option to export the entire dataset rather than only the filtered values.
- Delimiter: (CSV only.) Indicate which character should be used as a delimiter in the CSV. This can be one of Comma, Pipe, Semi Colon, Space, and Tab.
Note: Exporting and printing to JSON, XML, and CSV is not available in the Community edition.
Example: Output settings for other Output types
The following example shows the Output settings for PNGs, Power Point presentations, or Word documents:
The following example shows the Output settings for Excel spreadsheets:
The following example shows the Output settings for JSON or XML output:
The following example shows the Output settings for CSV output:
Selections
The Selections section of the Schedule Panel defines which values should be used in the slicers when the publication is built:
- Basic: If you do not select the Multi mode checkbox, then you need to define which value should be selected for each of the slicers in the publication when it is built on this schedule. For example, if you have Country and Manufacturer slicers in your publication, you will need to select the country (Australia, say) and manufacturer (ACME Corp) whose details should be used in the publication.
- Multi mode: If you select the Multi mode checkbox, you can select multiple values from each slicer to produce multiple copies of the publication; each of which is filtered by different values. For example, if you have the same slicers and select Multi mode, you publish a document for every country with one particular manufacturer, or for every country / manufacturer pair.
Note: The Selections section is only displayed if there are slicers in your publication.
Basic
Allows you to select a single slice option (element) for each slicer in the publication; filtering the publication according to the chosen elements:
Note: This functionality is the same as that used when you manually build your publication. One document is produced, filtered by one set of slicer options.
Multi mode
Allows you to select multiple values for each slicer and produce multiple copies of the publication, with each copy filtered by different values from the slicers.
To schedule building multiple documents with different slicer values:
- Select the Multi mode checkbox (purple arrow below).
- The drop-downs indicate which values to select for the slicers:
- All Items: Select all slices in the slicer (as described previously).
- First Item: Select the first slice in the slicer.
- Last Item: Select the last slice in the slicer.
- Custom: Enable custom selection of a slice. Once you have selected Custom, you use the drop-down again to select the custom slice. For example, to select Canada from the list of Countries.
- If you want to specify different combinations of items; for example, if you want to publish documents for All Manufacturers in Canada and one particular Manufacturer in the United States; you need to create multiple rows to define your selections:
- Click Plus (yellow arrow) to add a slicer selection.
- For each slicer, open the drop-down and select the "slice" type as above:
- To create a publication for each Manufacturer in Canada, you need to select Canada from the Country slicer (Custom) and All Items in the Manufacturer slicer.
- To also create a publication for the Manufacturer ACME in the United States, you need to add a row and select United States from the Country slicer (Custom) and ACME in the Manufacturer slicer (also Custom).
By default, a table is created with a column for each of the slicers in this publication. The default selection for each is All Items. If you accept this, your scheduled publication will be built for every possible combination of slicer items. This means that, if your slicers are Country and Manufacturer, you will create one publication for each manufacturer in every country (nine publications in total if your data includes three countries and three manufacturers).
Additional options
- Back: (Blue arrow above.) If you selected a Custom value, use the Back button to clear your selection from the drop-down.
- Delete: Remove a set of slicer selections, by deleting the row.
Schedule
The Schedule section of the Schedule Panel determines exactly when your schedule should run.
Once
Select Once from the drop-down to run the schedule once only, either immediately or at a specified time and date:
- Now: The schedule will run immediately.
- Delayed: The schedule will run at the specified time and date.
Timezone
Select the required timezone from the Timezone drop-down list. The schedule will run according to the selected timezone.
Recurring
Recurring schedules run on a regular frequency. Once you select the frequency of the schedule, you can set it to run at specified intervals; for example, every Monday, every quarter, or every two weeks:
- Run Now: Select this checkbox to run the schedule immediately.
- Hourly: Run the job every x hours and y minutes, starting from the specified Start time and date.
- Daily: Run the job either on the selected Specific Days or every x days (Days Interval).
- Weekly: Run the job every x weeks on the selected Days.
- Monthly: Run the job every x quarter, month, or all, based on the following pattern:
- Week and Days: Run the schedule during the specified week of the given months, on a given day.
- Calendar Days: Run the schedule on a given calendar day or on the last day of the month.
- Workdays: Run the schedule on a specific working day (Days) during the month, or on the last working day of the Month.
Start and End
For each recurring schedule option:
- Start: The date and time when the job starts running. All schedules need a Start date and time.
- End: Optional. The date and time when the job will stop running. If no end date and time are given, the schedule will continue running indefinitely.
Timezone
- Timezone: The timezone that your schedule should occur in. This is particularly important when building publications for a global audience.
On Demand
On Demand Schedules are used to trigger the rendering of specified publications, alerts, and subscriptions when the underlying data models are reprocessed.
To configure on demand scheduling for the subscriptions, choose On Demand from the Schedule section and configure on demand subscriptions for the relevant data models through the Master Flow or using the API.
- Click here to learn more about configuring the schedule.
Triggered Launch
Schedule your publication to only run if a certain condition or a series of conditions are met. Triggers are driven by query results. You can configure your own custom triggers, including model-refresh triggers, that will render publications and run alerts and subscriptions when the underlying data model is reprocessed. The trigger condition is defined using PQL.
- Click here to learn more about configuring a triggered launch.
Distribution
Determine how your publication will be delivered to any recipients. Publications can be distributed using Pyramid's bulletin board, one or more email addresses, or Webhook channels, as defined and configured in the Distribution section or the Schedule panel.
- Click here to learn about distribution options
Schedule Handling
- Schedule Timeout: Disables the scheduled task after the given amount of time.
- Disable Schedule after Consecutive Failures: The maximum number of consecutive failures allowed before the schedule is disabled.
- Time to Keep the Published Output: The length of time to keep rendered content (published output) for. This includes prints, publications, and subscriptions. The time set here cannot be greater than the overriding time set by the administrator in the system schedule.
Note: Selecting System Default for these options applies the default setting created by your administrator in the System Schedule.
Launching Schedules
Once you have defined all of the details of your Schedule you can make use of the following options:
- Save and Launch: (Purple arrow above.) Click this option to save your schedule and add it to the Scheduler queue. Once the scheduled time is reached, the associated jobs will run and the publications will be built and distributed as per your configuration.
- Go to schedule listings: (Green arrow.) Click this option to view the existing schedules for this publication in the Scheduling panel of the Content Explorer, where you can view the status of your job's execution and download the built output, among other available actions. For more details, see Scheduling and Subscriptions.
Related information
Data Source Authentication
If you’re using Windows Authentication or SAP Logon Tickets to connect to your data source, you may be prompted to enter Authentication credentials when saving your changes.
- Click here to learn more about Data Source Authentication.